From: Eli Zaretskii <eliz@gnu.org>
Date: Wed, 16 Apr 2025 08:13:41 +0000 (+0300)
Subject: ; Improve documentation of 'help-fns-edit-variable'
X-Git-Tag: archive/raspbian/1%30.2+1-2+rpi1^2~2^2~24^2~142
X-Git-Url: https://dgit.raspbian.org/%22http:/www.example.com/cgi/%22https:/www.github.com/%22bookmarks:///%22http:/www.example.com/cgi/%22https:/www.github.com/%22bookmarks:/?a=commitdiff_plain;h=275712a18c7e5ce38831721936fd9fb3ed3adb00;p=emacs.git

; Improve documentation of 'help-fns-edit-variable'

* lisp/help-fns.el (help-fns-edit-variable)
(help-enable-variable-value-editing): Doc fixes.

(cherry picked from commit bf737dc42a70fd8665b7c5ad506249a6119ec4c4)
---

diff --git a/lisp/help-fns.el b/lisp/help-fns.el
index c3433ad6015..980cc5b78a4 100644
--- a/lisp/help-fns.el
+++ b/lisp/help-fns.el
@@ -134,11 +134,11 @@ with the current prefix.  The files are chosen according to
   :version "26.3")
 
 (defcustom help-enable-variable-value-editing nil
-  "If non-nil, allow editing values in *Help* buffers.
+  "If non-nil, allow editing variable values in *Help* buffers.
 
 To edit the value of a variable, use \\[describe-variable] to
 display a \"*Help*\" buffer, move point after the text
-\"Its value is\" and type \\`e'.
+\"Its value is\" and type \\`e' to invoke `help-fns-edit-variable'.
 
 Values that aren't readable by the Emacs Lisp reader can't be
 edited even if this option is enabled."
@@ -1506,7 +1506,16 @@ it is displayed along with the global value."
 
 (put 'help-fns-edit-variable 'disabled t)
 (defun help-fns-edit-variable ()
-  "Edit the variable under point."
+  "Edit the variable value at point in \"*Help*\" buffer.
+This command only works if `help-enable-variable-value-editing' is non-nil.
+
+To edit the value of a variable, use \\[describe-variable] followed by the name
+of a variable, to display a \"*Help*\" buffer, move point to
+the variable's value, usually after the text \"Its value is\", and
+type \\`e' to invoke this command.
+
+Values that aren't readable by the Emacs Lisp reader can't be edited
+by this command."
   (declare (completion ignore))
   (interactive)
   (let ((var (get-text-property (point) 'help-fns--edit-variable)))